Plus Porter Version 0.5.1.0

PLUS PORTER
------------
Plus porter is an application that facilitates porting mods of the freeware PC game Cave Story to its
commercial counterpart, Cave Story+. The program works by letting the user gather all the modified
resources, and packages them into a patch that can be applied to an installation of Cave Story+. While
one could do most of this maually, Plus Porter makes doing so quicker and easier, and later versions will
feature extended functionality that will enable leagally sharing mods with partially edited spritesheets
while maintaining double resolution all throughout, one thing that can NOT be done manually.


GENERAL USAGE NOTES
--------------------

- Usage of this program requires that you have a copy of Cave Story+ on your hard drive. This program may
not perform as intended if the base files of your installation of Cave Story+ have been modified.

- As of version 0.5.1.0, nothing in the "add" submenu is functional, and the only options in the "replace"
submenu that are currently functional are the "Stage folder" and "Miscellaneous file" options. Additionally,
all of the "Add," Replace," and "View" buttons on the main panel do not do anything yet, save for the one
below the list of miscellaneous files.

- I take no responsibility for any damage this program may do to your computer. Use at your own risk.


COMPATIBILITY
--------------
This program should work on any Windows operating system XP and later.
It has not been tested on any other OS.


SETTING UP
-----------
There are two purposes Plus Porter serves: making ports, and applying ports
Before you can start using this program, however, you first must have a valid Cave Story+ directory to
reference to. To set this up, go to "File" -> "Open CS+ directory", and select the executable file located
in a valid Cave Story+ installation. If the installation has been successfully verified, you will be able to
access all the tools of Plus Porter. After you've done this once, the program will automatically open up the
last opened CS+ directory every subsequent time you launch the program. You can turn this check off in
preferences if you want to, though.


HOW TO APPLY PORTS
-------------------
To apply a port that has already been made, go to "File" -> "Open port...", browse to the folder of the
port you wish to open, and click "Open." After the port has been loaded, go to "File" -> "Apply port", and a
window will open up listing all mods currently installed in that game of CS+, and the order in which they'll
be listed in the challenge menu (with the one at the top appearing on the main menu). You are able to
arrange the mods in whatever order you want the challenge menu to list them, and then click the
"Apply port!" button to apply the port to your Cave Story+ installation. Exit out of plus porter, and you'll
now be able to experience the mod in Cave Story+.


HOW TO MAKE PORTS
------------------
To begin a new port, go to to "File" -> "New port...", and a window will pop up letting you set some basic
properties for your port. The port name will decide what name is shown when selecting your mod from the
challenge menu in Cave Story+, the folder name will define the name of the folder your port will be saved in,
and the description can include a quick blurb about your mod, although this field is not mandatory. If the
"Enable save slots" checkbox is checked, then you will be presented with three save slots when selecting
your mod. If it is left unchecked, then your mod will behave as a timed challenge. The requirement field
determines what you must do when playing the regular story mode in order to unlock the mod. If you want to
come back and edit these properties later, you may do so by going to "Settings" -> "Port Properties"

The first thing I recommend doing after that is importing the stage folder. To do this, go to "Edit" ->
"Replace" -> "Stage folder", and browse to your mod's stage folder. If a game executable is detected, you
will be prompted to import the map data from it in order to generate your mod's stage.tbl file. This will
then import all the maps from your mod.

If necessary, go to "Edit" -> "Replace..." -> "Miscellaneous file", and replace any global scripts, .tbl
files, or other generic files located in the base directory with files changed for your mod. When you've
set all the replacements you want, click the "Accept" button, and you'll have those generic files replaced.

This program currently does not support adding custom music or graphics, although later versions will.


CONTACT
--------
If you wish to contact me, first create an account on the Cave Story Tribute Site forums:
http://www.cavestory.org/forums/index.php

If you wish to make any comments, suggestions, or bug reports, then drop me a line here:
http://www.cavestory.org/forums/index.php?/topic/5338-plus-porter-alpha-0510/

If you wish to contact me directly, then message me here:
http://www.cavestory.org/forums/index.php?/user/2705-haydenstudios/